/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.spi.jumpto.file;

import org.openide.util.Lookup;

/**
 * Factory to create {@link FileProvider}s
 * The FileProviderFactory instances are registered in the global {@link Lookup}
 * @since 1.15
 * @author Tomas Zezula
 */
public interface FileProviderFactory {
    /**
     * Describe this provider with an internal name, used by logging.
     * @return An internal String uniquely identifying {@link FileProvider}, such as
     * "java"
     */
    String name();

    /**
     * Describe this provider for the user, used by logging.
     * @return A display name describing the {@link FileProvider}
     */
    String getDisplayName();


    /**
     * Reurns a {@link FileProvider} used in one session of Go To File action.
     * The returned provider is freed when the Go To File dialog is closed.
     * The {@link FileProvider} may cache some data to improve performance.
     * @return a new {@link FileProvider}
     */
    FileProvider createFileProvider();
}
